`POST /v1/capture/{token}/media`: stores one capture against the session. - Esectra

`POST /v1/capture/{token}/media`: stores one capture against the session.

curl --request POST \
  --url https://qa.esectra.com/v1/capture/{token}/media \
  --header 'Content-Type: application/json' \
  --data '
{
  "challenge_nonce": "<string>",
  "image_base64": "<string>",
  "media_type": "<string>",
  "declared_document": {
    "issuing_country": "<string>",
    "number_last4": "<string>"
  }
}
'

import requests

url = "https://qa.esectra.com/v1/capture/{token}/media"

payload = {
    "challenge_nonce": "<string>",
    "image_base64": "<string>",
    "media_type": "<string>",
    "declared_document": {
        "issuing_country": "<string>",
        "number_last4": "<string>"
    }
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    challenge_nonce: '<string>',
    image_base64: '<string>',
    media_type: '<string>',
    declared_document: {issuing_country: '<string>', number_last4: '<string>'}
  })
};

fetch('https://qa.esectra.com/v1/capture/{token}/media', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://qa.esectra.com/v1/capture/{token}/media",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'challenge_nonce' => '<string>',
    'image_base64' => '<string>',
    'media_type' => '<string>',
    'declared_document' => [
        'issuing_country' => '<string>',
        'number_last4' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://qa.esectra.com/v1/capture/{token}/media"

	payload := strings.NewReader("{\n  \"challenge_nonce\": \"<string>\",\n  \"image_base64\": \"<string>\",\n  \"media_type\": \"<string>\",\n  \"declared_document\": {\n    \"issuing_country\": \"<string>\",\n    \"number_last4\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://qa.esectra.com/v1/capture/{token}/media")
  .header("Content-Type", "application/json")
  .body("{\n  \"challenge_nonce\": \"<string>\",\n  \"image_base64\": \"<string>\",\n  \"media_type\": \"<string>\",\n  \"declared_document\": {\n    \"issuing_country\": \"<string>\",\n    \"number_last4\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://qa.esectra.com/v1/capture/{token}/media")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"challenge_nonce\": \"<string>\",\n  \"image_base64\": \"<string>\",\n  \"media_type\": \"<string>\",\n  \"declared_document\": {\n    \"issuing_country\": \"<string>\",\n    \"number_last4\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "awaiting": [
    "<string>"
  ],
  "stored": "<string>"
}

POST

/

v1

/

capture

/

{token}

/

media

`POST /v1/capture/{token}/media`: stores one capture against the session.

curl --request POST \
  --url https://qa.esectra.com/v1/capture/{token}/media \
  --header 'Content-Type: application/json' \
  --data '
{
  "challenge_nonce": "<string>",
  "image_base64": "<string>",
  "media_type": "<string>",
  "declared_document": {
    "issuing_country": "<string>",
    "number_last4": "<string>"
  }
}
'

import requests

url = "https://qa.esectra.com/v1/capture/{token}/media"

payload = {
    "challenge_nonce": "<string>",
    "image_base64": "<string>",
    "media_type": "<string>",
    "declared_document": {
        "issuing_country": "<string>",
        "number_last4": "<string>"
    }
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    challenge_nonce: '<string>',
    image_base64: '<string>',
    media_type: '<string>',
    declared_document: {issuing_country: '<string>', number_last4: '<string>'}
  })
};

fetch('https://qa.esectra.com/v1/capture/{token}/media', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://qa.esectra.com/v1/capture/{token}/media",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'challenge_nonce' => '<string>',
    'image_base64' => '<string>',
    'media_type' => '<string>',
    'declared_document' => [
        'issuing_country' => '<string>',
        'number_last4' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://qa.esectra.com/v1/capture/{token}/media"

	payload := strings.NewReader("{\n  \"challenge_nonce\": \"<string>\",\n  \"image_base64\": \"<string>\",\n  \"media_type\": \"<string>\",\n  \"declared_document\": {\n    \"issuing_country\": \"<string>\",\n    \"number_last4\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://qa.esectra.com/v1/capture/{token}/media")
  .header("Content-Type", "application/json")
  .body("{\n  \"challenge_nonce\": \"<string>\",\n  \"image_base64\": \"<string>\",\n  \"media_type\": \"<string>\",\n  \"declared_document\": {\n    \"issuing_country\": \"<string>\",\n    \"number_last4\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://qa.esectra.com/v1/capture/{token}/media")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"challenge_nonce\": \"<string>\",\n  \"image_base64\": \"<string>\",\n  \"media_type\": \"<string>\",\n  \"declared_document\": {\n    \"issuing_country\": \"<string>\",\n    \"number_last4\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "awaiting": [
    "<string>"
  ],
  "stored": "<string>"
}

Path Parameters

token

string

required

Single-use capture token

Body

application/json

One capture from the person being verified.

challenge_nonce

string

required

The session's nonce, echoed back.

image_base64

string

required

The capture itself.

kind

enum<string>

required

Which capture this is.

Available options:

SELFIE,

DOCUMENT

media_type

string

required

What the client says the bytes are.

declared_document

null | object

What the person says the document is, sent with the document capture.

Optional, and ignored on a selfie. An older capture client that does not send it still works; it declares nothing, and nothing is compared.

Show child attributes

Response

Accepted

What the subject is told. Deliberately thin - see the module docs.

awaiting

string[]

required

Whether Esectra still expects something else before it can finish.

stored

string

required

Which capture was stored.